IApi.WriteAxisOutputBit method

Writes a bit into an output of a real or simulated axis.

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.5.0.0

Syntax

C#VB

KsError WriteAxisOutputBit(
       int Index,
       int BitOffset,
       bool Value
)

Function WriteAxisOutputBit(
       Index As Integer,
       BitOffset As Integer,
       Value As Boolean
) As KsError

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

BitOffset

Type: int

Specifies a bit offset to the location to write a bit value. The max offset is determined by OutputLength in the SlaveStatus class.

Value

Type: bool

A value to write. true writes one (1) and false writes zero (0).

Return value

A return code of a method.

Remarks

WriteAxisOutputBit can only be called once a link is established and started.

Usable EtherCAT states

ecatOP

Examples

N/A